/*
Copyright (c) 2008, Adobe Systems Incorporated
All rights reserved.

Redistribution and use in source and binary forms, with or without 
modification, are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright notice, 
    	this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright notice, 
    	this list of conditions and the following disclaimer in the 
    	documentation and/or other materials provided with the distribution.
    * Neither the name of Adobe Systems Incorporated nor the names of its 
    	contributors may be used to endorse or promote products derived from 
    	this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
POSSIBILITY OF SUCH DAMAGE.
*/
/**
 * Broadcast as a result of the echo method being called
 *
 * The event contains the following properties
 *	success	- Boolean indicating if the call was successful or not
 *	data - When success is true, an XML object like the following:
 *				<method>flickr.test.echo</method>
 *				<param0>value</param0>
 *				<paramN>value</paramN>
 *
 *		   When success is false, contains an "error" FlickrError instance
 *
 * @see #echo
 * @see com.adobe.service.flickr.FlickrError
 * @see com.adobe.service.flickr.NameValuePair
 * @langversion ActionScript 3.0
 * @playerversion Flash 8.5
 * @tiptext
 */
// xxx [Event(name="testEcho",
// type="com.adobe.webapis.flickr.events.FlickrResultEvent")]
/**
 * Broadcast as a result of the login method being called
 *
 * The event contains the following properties
 *	success	- Boolean indicating if the call was successful or not
 *	data - When success is true, a User instance
 *
 *		   When success is false, contains an "error" FlickrError instance
 *
 * @see #login
 * @see com.adobe.service.flickr.FlickrError
 * @langversion ActionScript 3.0
 * @playerversion Flash 8.5
 * @tiptext
 */
// xxx [Event(name="testLogin",
// type="com.adobe.webapis.flickr.events.FlickrResultEvent")]
/**
 * Contains the methods for the Test method group in the Flickr API.
 * 
 * Even though the events are listed here, they're really broadcast
 * from the FlickrService instance itself to make using the service
 * easier.
 */
package com.adobe.webapis.flickr.methodgroups;

import com.adobe.webapis.flickr.events.FlickrResultEvent;
import com.adobe.webapis.flickr.*;
import flash.events.Event;
import flash.net.URLLoader;

class Test
{

	/** 
	 * A reference to the FlickrService that contains the api key
	 * and logic for processing API calls/responses
	 */
	var _service : FlickrService;
	/**
	 * Construct a new Test "method group" class
	 *
	 * @param service The FlickrService this method group
	 *		is associated with.
	 * @langversion ActionScript 3.0
	 * @playerversion Flash 8.5
	 * @tiptext
	 */
	public function new(service : FlickrService)
	{
		_service = service;
	}

	/**
	 * A testing method which echo's all paramaters back in 
	 * the response.
	 *
	 * @see http://www.flickr.com/services/api/flickr.test.echo.html
	 * @langversion ActionScript 3.0
	 * @playerversion Flash 8.5
	 * @tiptext
	 */
	public function echo() : Void
	{
		// Let the Helper do the work to invoke the method
		MethodGroupHelper.invokeMethod(_service, echo_result, "flickr.test.echo", false, params);
	}

	/**
	 * Capture the result of the echo message, and dispatch
	 * the event to anyone listening.
	 *
	 * @param event The complete event generated by the URLLoader
	 * 			that was used to communicate with the Flickr API
	 *			from the invokeMethod method in MethodGroupHelper
	 */
	function echo_result(event : Event) : Void
	{
		// Create a TEST_ECHO event
		var result : FlickrResultEvent = new FlickrResultEvent(FlickrResultEvent.TEST_ECHO);
		// Have the Helper handle parsing the result from the server - get the data
		// from the URLLoader which correspondes to the result from the API call
		MethodGroupHelper.processAndDispatch(_service, cast((event.target), URLLoader).data, result);
	}

	/**
	 * A testing method which checks if the caller is logged 
	 * in then returns their username.
	 *
	 * @see http://www.flickr.com/services/api/flickr.test.login.html
	 * @langversion ActionScript 3.0
	 * @playerversion Flash 8.5
	 * @tiptext
	 */
	public function login() : Void
	{
		// Let the Helper do the work to invoke the method
		MethodGroupHelper.invokeMethod(_service, login_result, "flickr.test.login", false);
	}

	/**
	 * Capture the result of the echo message, and dispatch
	 * the event to anyone listening.
	 *
	 * @param event The complete event generated by the URLLoader
	 * 			that was used to communicate with the Flickr API
	 *			from the invokeMethod method in MethodGroupHelper
	 */
	function login_result(event : Event) : Void
	{
		// Create a TEST_LOGIN event
		var result : FlickrResultEvent = new FlickrResultEvent(FlickrResultEvent.TEST_LOGIN);
		// Have the Helper handle parsing the result from the server - get the data
		// from the URLLoader which correspondes to the result from the API call
		MethodGroupHelper.processAndDispatch(_service, cast((event.target), URLLoader).data, result);
	}

}

